<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>libnetconf: Transaction API</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../libnetconf-logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">libnetconf
   &#160;<span id="projectnumber">0.5.99</span>
   </div>
   <div id="projectbrief">NETCONF Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="../../pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="../../modules.html"><span>Modules</span></a></li>
      <li><a href="../../annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="../../files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="../../search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('d8/d55/group__transapi.html','../../');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Transaction API</div>  </div>
</div><!--header-->
<div class="contents">

<p>libnetconf's implementation of transaction-based partial device reconfiguration.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/dcb/structtransapi__data__callbacks.html">transapi_data_callbacks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure binding location in configuration XML data and function callback applying changes.  <a href="../../d6/dcb/structtransapi__data__callbacks.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/df8/structtransapi__rpc__callbacks.html">transapi_rpc_callbacks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure binding location in configuration XML data and function callback processing RPC message.  <a href="../../d0/df8/structtransapi__rpc__callbacks.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d0d/structtransapi__xml__data__callbacks.html">transapi_xml_data_callbacks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="../../d6/dcb/structtransapi__data__callbacks.html" title="Structure binding location in configuration XML data and function callback applying changes...">transapi_data_callbacks</a>. Using libxml2 structures for callbacks parameters.  <a href="../../db/d0d/structtransapi__xml__data__callbacks.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d8c/structtransapi__xml__rpc__callbacks.html">transapi_xml_rpc_callbacks</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="../../d0/df8/structtransapi__rpc__callbacks.html" title="Structure binding location in configuration XML data and function callback processing RPC message...">transapi_rpc_callbacks</a>. Using libxml2 structures for callbacks parameters.  <a href="../../d6/d8c/structtransapi__xml__rpc__callbacks.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure holding information about used data model in YIN format  <a href="../../dd/de6/structmodel__tree.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d89/structxmldiff__entry.html">xmldiff_entry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure for single diff entry  <a href="../../d2/d89/structxmldiff__entry.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d38/structxmldiff.html">xmldiff</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure holding all differencies found in compared files  <a href="../../dc/d38/structxmldiff.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga10d59d84527f735d2781dbbb629a4488"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#ga10d59d84527f735d2781dbbb629a4488">XMLDIFF_OP</a> { <br/>
&#160;&#160;<a class="el" href="../../d8/d55/group__transapi.html#gga10d59d84527f735d2781dbbb629a4488af2c3cac34cb7553ac93e8f3ad8acee3c">XMLDIFF_ERR</a> = -1, 
<a class="el" href="../../d8/d55/group__transapi.html#gga10d59d84527f735d2781dbbb629a4488a45a3557c464a0d85a333b68634df5561">XMLDIFF_NONE</a> = 0, 
<a class="el" href="../../d8/d55/group__transapi.html#gga10d59d84527f735d2781dbbb629a4488adc0f4fc8354a1e293db5efd4f8e6f0b1">XMLDIFF_ADD</a> = 1, 
<a class="el" href="../../d8/d55/group__transapi.html#gga10d59d84527f735d2781dbbb629a4488a149cdeec9d87bdbb700861f773759129">XMLDIFF_REM</a> = 2, 
<br/>
&#160;&#160;<a class="el" href="../../d8/d55/group__transapi.html#gga10d59d84527f735d2781dbbb629a4488a27c20d1fff6c4a35673bea8c6bbe23c4">XMLDIFF_MOD</a> = 4, 
<a class="el" href="../../d8/d55/group__transapi.html#gga10d59d84527f735d2781dbbb629a4488a4038204cbce3cfa24153b304b95e99a6">XMLDIFF_CHAIN</a> = 8
<br/>
 }</td></tr>
<tr class="memdesc:ga10d59d84527f735d2781dbbb629a4488"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enum specifying states of node in document.  <a href="../../d8/d55/group__transapi.html#ga10d59d84527f735d2781dbbb629a4488">More...</a><br/></td></tr>
<tr class="separator:ga10d59d84527f735d2781dbbb629a4488"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga92fad6461f4d9f95f869756a02bc7449"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#ga92fad6461f4d9f95f869756a02bc7449">YIN_TYPE</a> { <br/>
&#160;&#160;<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449aacd2c9b118d093b8afb21bb2c22b0d49">YIN_TYPE_MODULE</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a798feec97a3268e7144a1f699e1533fa">YIN_TYPE_CONTAINER</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a564185e16a6d07021ca7dbe397e4e67d">YIN_TYPE_LEAF</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a0c5a05ccb6e46f6afdba80bfbd3a4c0e">YIN_TYPE_LIST</a>, 
<br/>
&#160;&#160;<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a58fb99e0e3a60d7f7a80be652dcac664">YIN_TYPE_LEAFLIST</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a3f952fc7e303c8fca79c2964e648a9cc">YIN_TYPE_CHOICE</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a938c0fccc9967ead7b83fb1163266661">YIN_TYPE_ANYXML</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a503a29739536901c09b9c6e5e1093b4e">YIN_TYPE_GROUPING</a>, 
<br/>
&#160;&#160;<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449ab2b36feefd221bcd8074856be8a4e296">YIN_TYPE_IMPORT</a>, 
<a class="el" href="../../d8/d55/group__transapi.html#gga92fad6461f4d9f95f869756a02bc7449a292109c2d37d5d798072371d08d36ae4">YIN_TYPE_AUGMENT</a>
<br/>
 }</td></tr>
<tr class="memdesc:ga92fad6461f4d9f95f869756a02bc7449"><td class="mdescLeft">&#160;</td><td class="mdescRight">enum type for yin/yang constructs  <a href="../../d8/d55/group__transapi.html#ga92fad6461f4d9f95f869756a02bc7449">More...</a><br/></td></tr>
<tr class="separator:ga92fad6461f4d9f95f869756a02bc7449"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga80e69b4cada8c35e5e358287e8af3d85"><td class="memItemLeft" align="right" valign="top">struct ncds_ds *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#ga80e69b4cada8c35e5e358287e8af3d85">ncds_new_transapi</a> (<a class="el" href="../../db/d67/group__store.html#gab0f0cbd5268577ec36fc76cf89c72a8f">NCDS_TYPE</a> type, const char *model_path, const char *callbacks_path)</td></tr>
<tr class="memdesc:ga80e69b4cada8c35e5e358287e8af3d85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create new datastore structure with transaction API support.  <a href="#ga80e69b4cada8c35e5e358287e8af3d85">More...</a><br/></td></tr>
<tr class="separator:ga80e69b4cada8c35e5e358287e8af3d85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21d851d64db3740f5dee102d3c3ffeb5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#ga21d851d64db3740f5dee102d3c3ffeb5">transapi_running_changed</a> (struct <a class="el" href="../../d6/dcb/structtransapi__data__callbacks.html">transapi_data_callbacks</a> *c, const char *ns_mapping[], xmlDocPtr old_doc, xmlDocPtr new_doc, struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *model)</td></tr>
<tr class="memdesc:ga21d851d64db3740f5dee102d3c3ffeb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Top level function of transaction API. Finds differences between old_doc and new_doc and calls specified callbacks.  <a href="#ga21d851d64db3740f5dee102d3c3ffeb5">More...</a><br/></td></tr>
<tr class="separator:ga21d851d64db3740f5dee102d3c3ffeb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab24457d58494b0edf1b4beee463aec5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#gaab24457d58494b0edf1b4beee463aec5">transapi_xml_running_changed</a> (struct <a class="el" href="../../db/d0d/structtransapi__xml__data__callbacks.html">transapi_xml_data_callbacks</a> *c, const char *ns_mapping[], xmlDocPtr old_doc, xmlDocPtr new_doc, struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *model)</td></tr>
<tr class="memdesc:gaab24457d58494b0edf1b4beee463aec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same functionality as <a class="el" href="../../d8/d55/group__transapi.html#ga21d851d64db3740f5dee102d3c3ffeb5" title="Top level function of transaction API. Finds differences between old_doc and new_doc and calls specif...">transapi_running_changed()</a>. Using libxml2 structures for callbacks parameters.  <a href="#gaab24457d58494b0edf1b4beee463aec5">More...</a><br/></td></tr>
<tr class="separator:gaab24457d58494b0edf1b4beee463aec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11b6f802a32c98b1605debb0ac4f1c57"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#ga11b6f802a32c98b1605debb0ac4f1c57">yinmodel_parse</a> (xmlDocPtr model_doc, const char *ns_mapping[])</td></tr>
<tr class="memdesc:ga11b6f802a32c98b1605debb0ac4f1c57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse YIN data model.  <a href="#ga11b6f802a32c98b1605debb0ac4f1c57">More...</a><br/></td></tr>
<tr class="separator:ga11b6f802a32c98b1605debb0ac4f1c57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4f5feae970a3c2840a248190f898314"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#gae4f5feae970a3c2840a248190f898314">yinmodel_free</a> (struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *yin)</td></tr>
<tr class="memdesc:gae4f5feae970a3c2840a248190f898314"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy yinmodel structure and free allocated memory.  <a href="#gae4f5feae970a3c2840a248190f898314">More...</a><br/></td></tr>
<tr class="separator:gae4f5feae970a3c2840a248190f898314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51f793ef3d02f47d83d8763d4c962304"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#ga51f793ef3d02f47d83d8763d4c962304">xmldiff_free</a> (struct <a class="el" href="../../dc/d38/structxmldiff.html">xmldiff</a> *diff)</td></tr>
<tr class="memdesc:ga51f793ef3d02f47d83d8763d4c962304"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy and free whole xmldiff structure.  <a href="#ga51f793ef3d02f47d83d8763d4c962304">More...</a><br/></td></tr>
<tr class="separator:ga51f793ef3d02f47d83d8763d4c962304"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac16efcedb0820928eb15db53623defd0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="../../dc/d38/structxmldiff.html">xmldiff</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d55/group__transapi.html#gac16efcedb0820928eb15db53623defd0">xmldiff_diff</a> (xmlDocPtr old, xmlDocPtr new, struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *model, const char *ns_mapping[])</td></tr>
<tr class="memdesc:gac16efcedb0820928eb15db53623defd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module top level function.  <a href="#gac16efcedb0820928eb15db53623defd0">More...</a><br/></td></tr>
<tr class="separator:gac16efcedb0820928eb15db53623defd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>libnetconf's implementation of transaction-based partial device reconfiguration. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga10d59d84527f735d2781dbbb629a4488"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d8/d55/group__transapi.html#ga10d59d84527f735d2781dbbb629a4488">XMLDIFF_OP</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enum specifying states of node in document. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga10d59d84527f735d2781dbbb629a4488af2c3cac34cb7553ac93e8f3ad8acee3c"></a>XMLDIFF_ERR</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga10d59d84527f735d2781dbbb629a4488a45a3557c464a0d85a333b68634df5561"></a>XMLDIFF_NONE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga10d59d84527f735d2781dbbb629a4488adc0f4fc8354a1e293db5efd4f8e6f0b1"></a>XMLDIFF_ADD</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga10d59d84527f735d2781dbbb629a4488a149cdeec9d87bdbb700861f773759129"></a>XMLDIFF_REM</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga10d59d84527f735d2781dbbb629a4488a27c20d1fff6c4a35673bea8c6bbe23c4"></a>XMLDIFF_MOD</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga10d59d84527f735d2781dbbb629a4488a4038204cbce3cfa24153b304b95e99a6"></a>XMLDIFF_CHAIN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="ga92fad6461f4d9f95f869756a02bc7449"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d8/d55/group__transapi.html#ga92fad6461f4d9f95f869756a02bc7449">YIN_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>enum type for yin/yang constructs </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449aacd2c9b118d093b8afb21bb2c22b0d49"></a>YIN_TYPE_MODULE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a798feec97a3268e7144a1f699e1533fa"></a>YIN_TYPE_CONTAINER</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a564185e16a6d07021ca7dbe397e4e67d"></a>YIN_TYPE_LEAF</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a0c5a05ccb6e46f6afdba80bfbd3a4c0e"></a>YIN_TYPE_LIST</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a58fb99e0e3a60d7f7a80be652dcac664"></a>YIN_TYPE_LEAFLIST</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a3f952fc7e303c8fca79c2964e648a9cc"></a>YIN_TYPE_CHOICE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a938c0fccc9967ead7b83fb1163266661"></a>YIN_TYPE_ANYXML</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a503a29739536901c09b9c6e5e1093b4e"></a>YIN_TYPE_GROUPING</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449ab2b36feefd221bcd8074856be8a4e296"></a>YIN_TYPE_IMPORT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga92fad6461f4d9f95f869756a02bc7449a292109c2d37d5d798072371d08d36ae4"></a>YIN_TYPE_AUGMENT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga80e69b4cada8c35e5e358287e8af3d85"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct ncds_ds* ncds_new_transapi </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d67/group__store.html#gab0f0cbd5268577ec36fc76cf89c72a8f">NCDS_TYPE</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>model_path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>callbacks_path</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create new datastore structure with transaction API support. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Datastore implementation type for the new datastore structure. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">model_path</td><td>Path to the YIN configuration data model. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">callbacks_path</td><td>Path to shared library with callbacks and other functions for transaction API.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Prepared (not configured) datastore structure. To configure the structure, caller must use the parameter setters of the specific datastore implementation type. Then, the datastore can be initiated (<a class="el" href="../../db/d67/group__store.html#gaabb1ae2c497726ad826fc6478f97e8ff" title="Activate datastore structure for use.">ncds_init()</a>) and used to access the configuration data. </dd></dl>

</div>
</div>
<a class="anchor" id="ga21d851d64db3740f5dee102d3c3ffeb5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int transapi_running_changed </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="../../d6/dcb/structtransapi__data__callbacks.html">transapi_data_callbacks</a> *&#160;</td>
          <td class="paramname"><em>c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns_mapping</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>old_doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>new_doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *&#160;</td>
          <td class="paramname"><em>model</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Top level function of transaction API. Finds differences between old_doc and new_doc and calls specified callbacks. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Structure binding callbacks with paths in XML document </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ns_mapping</td><td>Pairing prefixes with URIs. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">old_doc</td><td>Content of configuration datastore before change. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">new_doc</td><td>Content of configuration datastore after change. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">model</td><td>Structure holding document semantics.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>EXIT_SUCESS or EXIT_FAILURE </dd></dl>

</div>
</div>
<a class="anchor" id="gaab24457d58494b0edf1b4beee463aec5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int transapi_xml_running_changed </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="../../db/d0d/structtransapi__xml__data__callbacks.html">transapi_xml_data_callbacks</a> *&#160;</td>
          <td class="paramname"><em>c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns_mapping</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>old_doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>new_doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *&#160;</td>
          <td class="paramname"><em>model</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Same functionality as <a class="el" href="../../d8/d55/group__transapi.html#ga21d851d64db3740f5dee102d3c3ffeb5" title="Top level function of transaction API. Finds differences between old_doc and new_doc and calls specif...">transapi_running_changed()</a>. Using libxml2 structures for callbacks parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Structure binding callbacks with paths in XML document. Callbacks uses libxml2 structures. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ns_mapping</td><td>Pairing prefixes with URIs. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">old_doc</td><td>Content of configuration datastore before change. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">new_doc</td><td>Content of configuration datastore after change. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">model</td><td>Structure holding document semantics.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>EXIT_SUCESS or EXIT_FAILURE </dd></dl>

</div>
</div>
<a class="anchor" id="ga11b6f802a32c98b1605debb0ac4f1c57"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a>* yinmodel_parse </td>
          <td>(</td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>model_doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns_mapping</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse YIN data model. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">model_doc</td><td>Data model in YIN format. </td></tr>
    <tr><td class="paramname">ns_mapping</td><td>Pairing prefixes with URIs.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>yinmodel structure or NULL </dd></dl>

</div>
</div>
<a class="anchor" id="gae4f5feae970a3c2840a248190f898314"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void yinmodel_free </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *&#160;</td>
          <td class="paramname"><em>yin</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy yinmodel structure and free allocated memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">yin</td><td>Structure to be freed. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga51f793ef3d02f47d83d8763d4c962304"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xmldiff_free </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="../../dc/d38/structxmldiff.html">xmldiff</a> *&#160;</td>
          <td class="paramname"><em>diff</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy and free whole xmldiff structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">diff</td><td>pointer to xmldiff structure </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gac16efcedb0820928eb15db53623defd0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="../../dc/d38/structxmldiff.html">xmldiff</a>* xmldiff_diff </td>
          <td>(</td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>old</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmlDocPtr&#160;</td>
          <td class="paramname"><em>new</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="../../dd/de6/structmodel__tree.html">model_tree</a> *&#160;</td>
          <td class="paramname"><em>model</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ns_mapping</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Module top level function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">old</td><td>old version of XML document </td></tr>
    <tr><td class="paramname">new</td><td>new version of XML document </td></tr>
    <tr><td class="paramname">model</td><td>data model in YANG format </td></tr>
    <tr><td class="paramname">ns_mapping</td><td>Pairing prefixes with URIs</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>xmldiff structure holding all differences between XML documents or NULL </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Fri Jun 21 2013 14:17:42 for libnetconf by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li>
  </ul>
</div>
</body>
</html>
